Bundle org.nuxeo.runtime.metrics

Documentation

README.md
About nuxeo-runtime-metrics

Since Nuxeo 5.7 Coda Hale Yammer Metrics is used to add metrics to Nuxeo. This module is here to configure the metrics reporter and add default metrics.

For testing you can run a graphite/grafana stack using the provided docker compose:
```
cd ./docker/graphite-grafana
docker-compose up -d
```
Then configure your nuxeo.conf to report metrics and restart Nuxeo:
```
metrics.graphite.enabled=true
metrics.graphite.host=localhost
metrics.graphite.port=2003
metrics.graphite.period=30
metrics.tomcat.enabled=true
metrics.log4j.enabled=true
```
Access Grafana using http://localhost:3000 with user: admin pwd: admin, you should have a Nuxeo Grafana dashboard up and running.

Graphite is also reachable http://localhost:8000

To stop Grafana (loosing all data):
```
docker-compose down
```
For production you should use different retentions and docker volumes to persist data.

You can also find old example of json graphite dashboard graphite directory. To use it from Graphite Dashboard > Edit Dashboard, paste the content

See http://doc.nuxeo.org/ for full documentation. See http://metrics.codahale.com/ for Metrics documentation.

Resolution Order

808

The resolution order represents the order in which this bundle's single component has been resolved by the Nuxeo Runtime framework.
You can influence this order by adding "require" tags in the component declaration, to make sure it is resolved after another component. It will also impact the order in which contributions are registered on their target extension point (see "Registration Order" on contributions).

Components

org.nuxeo.runtime.metrics.MetricsService

Maven Artifact

File	nuxeo-runtime-metrics-2023.9.10.jar
Group Id	org.nuxeo.runtime
Artifact Id	nuxeo-runtime-metrics
Version	2023.9.10

Manifest

Manifest-Version: 1.0
Archiver-Version: Plexus Archiver
Created-By: Apache Maven 3.6.1
Built-By: root
Build-Jdk: 17.0.10
Bundle-ManifestVersion: 1
Bundle-Version: 2023.9.10-t20240314-013938
Bundle-Name: Nuxeo Runtime Metrics
Bundle-SymbolicName: org.nuxeo.runtime.metrics;singleton:=true
Bundle-Vendor: Nuxeo
Nuxeo-Component: OSGI-INF/runtime-metrics-service.xml

Exports

Json Export Default Json serialization
Json Graph Json dependency graph
Json Contribution Stats Json statistics for contributions
CSV Contribution Stats CSV statistics for contributions

Charts

Raw Data: Json Contribution Stats

Contributions by Code Type

Loading data

Contributions by Target Extension Point

Loading data

Contributions by Studio Source

Loading data